﻿/*
 * Copyright (c) Jason Paul Morley, 2010
 * Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Core
{
    /// <summary>
    /// An abstract step used to provide a demonstration of the solution
    /// </summary>
    public interface IStep
    {
        /// <summary>
        /// Apply the step
        /// </summary>
        void Apply();

        /// <summary>
        /// Undo the changes made by this step
        /// </summary>
        void Undo();

        /// <summary>
        /// Removes the unneeded changes made by this step
        /// </summary>
        void ToNext();

        /// <summary>
        /// Gets the name of the step which is most likely
        /// used to display the step in a generated list
        /// </summary>
        /// <returns></returns>
        string Name();
    }
}
